Add new Firmware TPM (fwTPM) by dgarske · Pull Request #474 · wolfSSL/wolfTPM

dgarske · 2026-03-21T16:45:14Z

Summary

Add firmware TPM 2.0 server (fwTPM) implementing TPM 2.0 spec v1.38 (105/113 commands, 93% coverage)
Spec-compliant primary key derivation: deterministic RSA (iterative KDFa prime generation), ECC (KDFa scalar, Q=d*G), KEYEDHASH/SYMCIPHER keys — same seed + template always produces the same key
ChangePPS / ChangeEPS hierarchy commands with seed regeneration and cache flush
NV storage with TLV journal format (flash-friendly, append-only)
Socket (mssim) and TIS/SHM transports for desktop, UART transport for embedded
STM32 Cortex-M33 bare-metal port with TrustZone (CMSE) support
Shared crypto refactoring: extract KDFa/KDFe, AES-CFB, HMAC/Hash to tpm2_crypto.c
Bounds-checked TPM2_Packet_ParseU16Buf variant for safer response parsing
Auth validation: reject oversized auth values instead of silent truncation
SIGTERM/SIGINT signal handler for graceful NV save on server kill

fwTPM Server

Core TPM 2.0 command processing in src/fwtpm/:

fwtpm_command.c — 105 command handlers with full auth, sessions, parameter encryption
fwtpm_nv.c — TLV journal NV storage (file-based default, HAL-abstracted for flash)
fwtpm_io.c — Socket transport (mssim + swtpm protocol auto-detection)
fwtpm_tis.c / fwtpm_tis_shm.c — TIS register interface via POSIX shared memory
fwtpm_crypto.c — Key generation, sign/verify, seed encrypt/decrypt helpers
Clock HAL with NV-persisted clockOffset

Build: ./configure --enable-fwtpm && make

Example: wolfSSL/wolftpm-examples#1

Primary Key Derivation (TPM 2.0 Part 1 Section 26)

RSA: iterative KDFa prime generation with labels "RSA p" / "RSA q"
ECC: KDFa scalar derivation, public point Q = d*G
KEYEDHASH/SYMCIPHER: KDFa with algorithm-specific labels
hashUnique = H(sensitiveCreate.data || unique) per Section 26.1
Primary cache retained as performance optimization, no longer required for correctness

UART Transport (`--enable-swtpm=uart`)

New transport option for wolfTPM client library to communicate with embedded fwTPM over serial:

./configure --enable-swtpm=uart — uses termios serial I/O instead of TCP sockets
TPM2_SWTPM_HOST env var selects serial device at runtime
Same mssim protocol as socket transport (compatible with all wolfTPM examples)

Testing

311 tpm2-tools compatibility tests (scripts/tpm2_tools_test.sh)
Full wolfTPM example suite (examples/run_examples.sh)
libFuzzer harness with corpus generator (tests/fuzz/)
m33mu Cortex-M33 emulator CI test (scripts/fwtpm_emu_test.sh)
ASan / UBSan clean
20 CI matrix configurations (pedantic gcc/clang -Werror, sanitizers, feature-disable variants)

…_examples.sh and tpm2_tools_test.sh to make test for fwtpm as well

danielinux · 2026-04-03T07:50:15Z

src/fwtpm/fwtpm_nv.c

+    pkt.pos = 2; /* skip size we already read */
+    TPM2_Packet_ParsePublic(&pkt, &pub2b);
+    XMEMCPY(pub, &pub2b.publicArea, sizeof(TPMT_PUBLIC));
+    *pos += pubSz;


This calls TPM2_Packet_ParsePublic which parses the size again. I think restoring might corrupt saved records. Please verify with a test

danielinux · 2026-04-03T07:52:21Z

src/fwtpm/fwtpm_nv.c

+    /* Check if journal has space */
+    if (ctx->nvWritePos + entrySize > hal->maxSize) {
+        /* Compact and retry */
+        rc = FWTPM_NV_Save(ctx);


cyclic recursion seems possible between FWTPM_NV_Save and FwNvAppendEntry if compacting is not sufficient the functions will keep calling each other

danielinux · 2026-04-03T07:57:01Z

src/fwtpm/fwtpm_command.c

+            FwFlushAllSessions(ctx);
+        }
+
+        FWTPM_NV_Save(ctx);


Return value is discarded here, this functions will return success regardless of FWTPM_NV_Save result. Review error handling in this function.

- Fixed LE/BE endianness mismatch in FwNvMarshalPublic/FwNvUnmarshalPublic - Added nvCompacting guard to prevent infinite recursion between FwNvAppendEntry and FWTPM_NV_Save - Check FWTPM_NV_Save return value in FwCmd_Shutdown and other callers - Reinitialize hash context per iteration in TPM2_KDFe_ex for multi-block derivation - Align packet->pos to inSensSize boundary in ParseSensitiveCreate - Clean up wolfCrypt resources if FWTPM_NV_Init fails in FWTPM_Init - Reset g_initialized on fuzzer reinit failure - Fix configure.ac so --enable-swtpm=uart doesn't force TIS mode - Update README command count from 103/91% to 105/93%

- Fixed memory leak in FwComputeRpHash — initialized rc = 0, added FWTPM_FREE_VAR(hashCtx) before both early returns to prevent heap leak under WOLFTPM_SMALL_STACK - Removed static from eccUniqueBuf in FwCmd_CreatePrimary — eliminates thread-safety risk and stale data persistence across calls (132-byte buffer is fine on stack) - Initialized rc = TPM_RC_SUCCESS in FWTPM_ProcessCommand — prevents use of uninitialized variable - Added XMEMSET(cmdAuths, 0, sizeof(cmdAuths)) in FWTPM_ProcessCommand — zeroes auth struct array to prevent use of garbage data on partial parse - Added auth-parse error check — if auth area parsing fails (e.g. TPM_RC_AUTHSIZE), returns error response instead of falling through to command dispatch - Moved pwSz/avSz into inner scope — declared where actually used instead of function scope - Added TPM2_ForceZero(&bindAuth, ...) in FwCmd_StartAuthSession — zeroizes hierarchy auth secrets before scope exit - Fixed NV handle mask consistency — changed == NV_INDEX_FIRST to == (NV_INDEX_FIRST & 0xFF000000) to match style elsewhere - Added wc_HmacInit() in FwWrapPrivate — call wc_HmacInit before wc_HmacSetKey, matching pattern used in FwComputeSessionHmac and FwDeriveWrapKey - Added wc_HmacInit() in FwUnwrapPrivate — same fix for the unwrap path - Fixed UART (void)port suppression — removed erroneous cast that hid the fact port is used later - Added NULL check before atoi(port) — prevents undefined behavior if port is NULL - Restored idx >= inputSz bounds check in TPM2_ASN_DecodeX509Cert — defense-in-depth against OOB read on malformed certificates - Restored *sigSz < 3 minimum in TPM2_ASN_RsaUnpadPkcsv15 — valid PKCS#1 v1.5 needs at least 0x00|0x01|0xFF - Fixed summary alignment — consistent column spacing for fwTPM output lines

dgarske requested a review from aidangarske March 21, 2026 19:08

dgarske assigned dgarske and aidangarske Mar 21, 2026

dgarske requested a review from wolfSSL-Fenrir-bot March 21, 2026 19:09

This comment was marked as resolved.

Sign in to view

dgarske force-pushed the fwtpm branch 3 times, most recently from 9c0208f to eae465e Compare March 21, 2026 23:51

dgarske changed the title ~~Add fwTPM firmware TPM 2.0 server with STM32 port~~ Add fwTPM firmware TPM 2.0 server Mar 21, 2026

dgarske changed the title ~~Add fwTPM firmware TPM 2.0 server~~ Add new Firmware TPM (fwTPM) Mar 22, 2026

dgarske force-pushed the fwtpm branch 2 times, most recently from b186ecc to f529484 Compare March 23, 2026 21:28

dgarske assigned wolfSSL-Bot and unassigned dgarske and aidangarske Mar 24, 2026

Add new Firmware TPM (fwTPM)

0435a71

dgarske force-pushed the fwtpm branch from 0f059f9 to 0435a71 Compare March 25, 2026 00:11

dgarske assigned dgarske and unassigned wolfSSL-Bot Mar 25, 2026

dgarske added 3 commits March 24, 2026 17:25

Fixes to support no SHA-384. Fix fwtpm emulator build/test

a06ad5f

Fix CI issues

7c0b794

Cleanups for production rediness

647b3d2

aidangarske requested a review from wolfSSL-Fenrir-bot March 25, 2026 17:21

This comment was marked as resolved.

Sign in to view

Address internal static analyisis findings, add unit testing, add run…

4279711

…_examples.sh and tpm2_tools_test.sh to make test for fwtpm as well

aidangarske requested review from Copilot and wolfSSL-Fenrir-bot March 25, 2026 20:20

Copilot started reviewing on behalf of aidangarske March 25, 2026 20:22 View session

This comment was marked as resolved.

Sign in to view

aidangarske added 2 commits March 25, 2026 13:40

Fix CI and address feedback

63a4e27

Fix unused function warning in fwtpm_unit_tests.c

42f2916

aidangarske requested a review from danielinux March 25, 2026 20:51

danielinux requested changes Apr 3, 2026

View reviewed changes

Fix endianness mismatch, cyclic recursion, and ignored return values

d2f9c94

Copilot AI review requested due to automatic review settings April 3, 2026 17:42

Copilot started reviewing on behalf of aidangarske April 3, 2026 17:44 View session

This comment was marked as resolved.

Sign in to view

aidangarske requested review from Copilot and wolfSSL-Fenrir-bot April 3, 2026 17:51

Copilot started reviewing on behalf of aidangarske April 3, 2026 17:51 View session

This comment was marked as resolved.

Sign in to view

aidangarske removed their request for review April 3, 2026 18:55

aidangarske self-assigned this Apr 3, 2026

aidangarske requested a review from danielinux April 3, 2026 19:21

dgarske assigned danielinux and wolfSSL-Bot and unassigned aidangarske and dgarske Apr 5, 2026

aidangarske requested review from Copilot and removed request for Copilot April 6, 2026 19:13

Copilot started reviewing on behalf of aidangarske April 6, 2026 20:24 View session

Move eccUniqueBuf out of in case decleration

981aa70

Copilot AI review requested due to automatic review settings April 6, 2026 22:12

Copilot started reviewing on behalf of aidangarske April 6, 2026 22:14 View session

This comment was marked as resolved.

Sign in to view

Address copilot and skoll review

a5bf06c

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add new Firmware TPM (fwTPM)#474

Add new Firmware TPM (fwTPM)#474
dgarske wants to merge 12 commits intowolfSSL:masterfrom
dgarske:fwtpm

dgarske commented Mar 21, 2026 •

edited

Loading

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

danielinux Apr 3, 2026

Uh oh!

danielinux Apr 3, 2026

Uh oh!

danielinux Apr 3, 2026

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Conversation

dgarske commented Mar 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

fwTPM Server

Primary Key Derivation (TPM 2.0 Part 1 Section 26)

UART Transport (--enable-swtpm=uart)

Testing

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

danielinux Apr 3, 2026

Choose a reason for hiding this comment

Uh oh!

danielinux Apr 3, 2026

Choose a reason for hiding this comment

Uh oh!

danielinux Apr 3, 2026

Choose a reason for hiding this comment

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

dgarske commented Mar 21, 2026 •

edited

Loading

UART Transport (`--enable-swtpm=uart`)